All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class quicktime.vr.QTVRInstance

java.lang.Object
   |
   +----quicktime.QTObject
           |
           +----quicktime.vr.QTVRInstance

public final class QTVRInstance

extends QTObject

implements QuickTimeLib, QuickTimeVRLib

If an application installs any of the QTVR callbacks, then it must remove these callbacks when it has finished with them (or with the QTVRInstance itself) to allow the native structures used to be properly disposed.

QTVRInstance(Track, MovieController)

You can use the QTVRGetQTVRInstance function to get an instance of a QuickTime VR movie.

callInterceptedProc(QTVRInterceptRecord)

This method is used by the QTVRInterceptor execute method to call the QTVR default proc for the selector that was intercepted.

columnToPan(int)

You can use QTVRColumnToPan to get the pan angle that corresponds to a column number in the object image array.

enableHotSpot(int, int, boolean)

You can use the QTVREnableHotSpot function to enable or disable one or more hot spots.

getAngularUnits()

You can use QTVRGetAngularUnits to get the type of unit currently used when specifying angles.

getConstraints_max(int)

You can use the QTVRGetConstraints function to get the current constraints of a movie.

getConstraints_min(int)

You can use the QTVRGetConstraints function to get the current constraints of a movie.

getCurrentNodeID()

You can use the QTVRGetCurrentNodeID function to get the current node of a movie.

getFieldOfView()

You can use the QTVRGetFieldOfView function to get the vertical field of view of a QuickTime VR movie.

getHotSpotType(int)

This method gets the type of a hot spot whose ID you specify.

getImagingProperty(int, int)

You can use the QTVRGetImagingProperty function to get the current value of an imaging property of a movie.

getNodeInfo(int)

You can use the QTVRGetNodeInfo function to get the node information atom container that describes a node and all the hot spots in the node.

getNodeType(int)

You can use the QTVRGetNodeType function to get the OSType of a movie node.

getPanAngle()

You can use the QTVRGetPanAngle function to get the pan angle of a QuickTime VR movie.

getTiltAngle()

You can use the QTVRGetTiltAngle function to get the tilt angle of a QuickTime VR movie.

getViewCenter()

The getViewCenter method returns, in the QDPoint class, the x and y coordinates of the current view center of the QuickTime VR movie specified by the QTVRInstance you call this on.

getVRWorld()

The QTVRGetVRWorld function returns an atom container that contains general scene information about the QuickTime VR movie specified, as well as a list of all the nodes in that movie.

goToNodeID(int)

You can use the QTVRGoToNodeID function to set the current node of a movie.

installInterceptProc(int, QTVRInterceptor, int)

You can use the QTVRInstallInterceptProc function to install or remove an intercept procedure for a QuickTime VR Manager function

QuickTime::QTVRInstallInterceptProc

nudge(int)

You can use the QTVRNudge function to turn one step in a particular direction and display the new view.

panToColumn(float)

You can use QTVRPanToColumn to get the column number in the object image array that corresponds to a pan angle.

ptToPanAngle(QDPoint)

You can use QTVRPtToAngles to get the pan angle of a point.

ptToTiltAngle(QDPoint)

You can use QTVRPtToAngles to get the tilt angle of a point.

removeEnteringNodeProc()

You can use the QTVRSetEnteringNodeProc function to remove a node-entering procedure.

removeInterceptProc(int)

You can use the QTVRInstallInterceptProc function to install or remove an intercept procedure for a QuickTime VR Manager function

QuickTime::QTVRInstallInterceptProc

removeLeavingNodeProc()

You can use the QTVRSetLeavingNodeProc function to remove a node-leaving procedure.

removeMouseOverHotSpotProc()

You can use the QTVRSetMouseOverHotSpotProc function to remove a mouse over hot spot procedure.

removePrescreenImagingCompleteProc()

You can use the QTVRSetPrescreenImagingCompleteProc function to remove a prescreen imaging complete proc.

rowToTilt(int)

You can use QTVRRowToTilt to get the tilt angle that corresponds to a row number in the object image array.

setAngularUnits(int)

You can use QTVRSetAngularUnits to set the type of unit used when specifying angles.

setConstraints(int, float, float)

You can use the QTVRSetConstraints function to set the constraints of a movie.

setEnteringNodeProc(QTVREnteringNode, int)

You can use the QTVRSetEnteringNodeProc function to install or remove a node-entering procedure.

setFieldOfView(float)

You can use the QTVRSetFieldOfView function to set the vertical field of view of a QuickTime VR movie.

setImagingProperty(int, int, int)

You can use the QTVRSetImagingProperty function to set the current value of an imaging property of a movie.

setLeavingNodeProc(QTVRLeavingNode, int)

You can use the QTVRSetLeavingNodeProc function to install or remove a node-leaving procedure.

setMouseOverHotSpotProc(QTVRMouseOverHotSpot, int)

You can use the QTVRSetMouseOverHotSpotProc function to install or remove a mouse over hot spot procedure

QuickTime::QTVRSetMouseOverHotSpotProc

setPanAngle(float)

You can use the QTVRSetPanAngle function to set the pan angle of a QuickTime VR movie.

setPrescreenImagingCompleteProc(QTVRImagingComplete, int)

This method installs a callback that is invoked every time a QTVRInstance is drawn.

setTiltAngle(float)

You can use the QTVRSetTiltAngle function to set the tilt angle of a QuickTime VR movie.

setViewCenter(QDPoint)

The setViewCenter method sets the view center of the QuickTime VR movie specified by the qtvr parameter to the fixed point specified by the viewCenter parameter.

showDefaultView()

The showDefaultView method sets the default values of the pan angle, tilt angle, field of view, view center (for object nodes), default state, mouse-down state, and all applicable animation and control settings for the node specified by the QTVRInstance you call this on.

tiltToRow(float)

You can use QTVRTiltToRow to get the row number in the object image array that corresponds to a tilt angle.

triggerHotSpot(int, AtomContainer, Atom)

You can use the QTVRTriggerHotSpot function to trigger a hot spot.

update(int)

You can use the QTVRUpdate function to force an immediate update of a QuickTime VR movie image.

wrapAndConstrain(int, float)

You can use QTVRWrapAndConstrain to preflight a change in the viewing or control characteristics of an object or panoramic node.

 public QTVRInstance(Track qtvrTrack,
                     MovieController mc) throws QTException

You can use the QTVRGetQTVRInstance function to get an instance of a QuickTime VR movie.

QuickTime::QTVRGetQTVRInstance

Parameters:

qtvrTrack - A QTVR track contained in a QuickTime movie. You can obtain a reference to this track by calling QTVRGetQTVRTrack

mc - A movie controller that is associated with the new QuickTime VR movie

 public AtomContainer getVRWorld() throws QTVRException

The QTVRGetVRWorld function returns an atom container that contains general scene information about the QuickTime VR movie specified, as well as a list of all the nodes in that movie.

QuickTime::QTVRGetVRWorld

Returns:

the VRWorld AtomContainer

 public AtomContainer getNodeInfo(int nodeID) throws QTVRException

You can use the QTVRGetNodeInfo function to get the node information atom container that describes a node and all the hot spots in the node.

QuickTime::QTVRGetNodeInfo

Parameters:

nodeID - Set this parameter to kQTVRCurrentNode to receive information about the current node

Returns:

an atom container that contains information about the specified node.

 public int getCurrentNodeID()

You can use the QTVRGetCurrentNodeID function to get the current node of a movie.

QuickTime::QTVRGetCurrentNodeID

Returns:

the ID of the current node of the specified movie.

 public int getNodeType(int nodeID)

You can use the QTVRGetNodeType function to get the OSType of a movie node.

QuickTime::QTVRGetNodeType

Parameters:

nodeID - A node ID. Pass kQTVRCurrentNode for the current node.

Returns:

the type of the specified node.

 public void triggerHotSpot(int hotSpotID,
                            AtomContainer nodeInfo,
                            Atom selectedAtom) throws QTVRException

You can use the QTVRTriggerHotSpot function to trigger a hot spot. Usually, you need only specify the qtvr instance and the hot spot ID. You can pass zero for the nodeInfo and selectedAtom parameters.

QuickTime::QTVRTriggerHotSpot

Parameters:

hotSpotID - A hot spot ID.

nodeInfo - A node information atom container (obtained from a previous call to QTVRGetNodeInfo). You can pass the value 0 in this parameter to have the QuickTime VR Manager determine the appropriate node information atom container.

selectedAtom - The atom of the hot spot to trigger. You can pass the value 0 in this parameter to have the QuickTime VR Manager determine the appropriate hot spot atom.

 public void enableHotSpot(int enableFlag,
                           int hotSpotValue,
                           boolean enable) throws QTVRException

You can use the QTVREnableHotSpot function to enable or disable one or more hot spots.

QuickTime::QTVREnableHotSpot

Parameters:

enableFlag - The kind of hot spot or hot spots to enable or disable.

hotSpotValue - The desired hot spot or spots, relative to the specified enabled flag.

enable - A Boolean value that indicates whether the specified hot spots are to be enabled (true) or disabled (false).

 public void update(int imagingMode) throws QTVRException

You can use the QTVRUpdate function to force an immediate update of a QuickTime VR movie image.

QuickTime::QTVRUpdate

Parameters:

imagingMode - An imaging mode. You can specify the kQTVRCurrentMode imaging mode to use the current imaging mode.

 public void goToNodeID(int nodeID) throws QTVRException

You can use the QTVRGoToNodeID function to set the current node of a movie.

QuickTime::QTVRGoToNodeID

Parameters:

nodeID - The ID of the node you want to be the current node.

 public void nudge(int direction) throws QTVRException

You can use the QTVRNudge function to turn one step in a particular direction and display the new view.

QuickTime::QTVRNudge

Parameters:

direction - The direction of the nudge.

 public float getPanAngle()

You can use the QTVRGetPanAngle function to get the pan angle of a QuickTime VR movie.

QuickTime::QTVRGetPanAngle

Returns:

a floating-point value that represents the current pan angle of the specified movie.

 public void setPanAngle(float panAngle) throws QTVRException

You can use the QTVRSetPanAngle function to set the pan angle of a QuickTime VR movie.

QuickTime::QTVRSetPanAngle

Parameters:

panAngle - The desired pan angle of the specified movie.

 public float getTiltAngle()

You can use the QTVRGetTiltAngle function to get the tilt angle of a QuickTime VR movie.

QuickTime::QTVRGetTiltAngle

Returns:

a floating-point value that represents the current tilt angle of the specified movie.

 public void setTiltAngle(float tiltAngle) throws QTVRException

You can use the QTVRSetTiltAngle function to set the tilt angle of a QuickTime VR movie.

QuickTime::QTVRSetTiltAngle

Parameters:

tiltAngle - The desired tilt angle of the specified movie.

 public float getFieldOfView()

You can use the QTVRGetFieldOfView function to get the vertical field of view of a QuickTime VR movie.

QuickTime::QTVRGetFieldOfView

Returns:

the current vertical field of view of the specified movie.

 public void setFieldOfView(float fieldOfView) throws QTVRException

You can use the QTVRSetFieldOfView function to set the vertical field of view of a QuickTime VR movie.

QuickTime::QTVRSetFieldOfView

Parameters:

fieldOfView - The desired vertical field of view for the specified movie.

 public float getConstraints_min(int kind) throws QTVRException

You can use the QTVRGetConstraints function to get the current constraints of a movie.

QuickTime::QTVRGetConstraints

Parameters:

kind - The type of constraints to be returned.

 public float getConstraints_max(int kind) throws QTVRException

You can use the QTVRGetConstraints function to get the current constraints of a movie.

QuickTime::QTVRGetConstraints

Parameters:

kind - The type of constraints to be returned.

 public void setConstraints(int kind,
                            float minValue,
                            float maxValue) throws QTVRException

You can use the QTVRSetConstraints function to set the constraints of a movie.

QuickTime::QTVRSetConstraints

Parameters:

kind - The type of constraint to set..

minValue - A floating-point value that contains the desired minimum constraint of the specified type.

maxValue - A floating-point value that contains the desired maximum constraint of the specified type.

 public void setImagingProperty(int imagingMode,
                                int imagingProperty,
                                int propertyValue) throws QTVRException

You can use the QTVRSetImagingProperty function to set the current value of an imaging property of a movie.

QuickTime::QTVRSetImagingProperty

Parameters:

imagingMode - an imaging mode.

imagingProperty - an imaging property.

propertyValue - sets the current value of the specified imaging property for the specified mode.

 public int getImagingProperty(int imagingMode,
                               int imagingProperty) throws QTVRException

You can use the QTVRGetImagingProperty function to get the current value of an imaging property of a movie.

QuickTime::QTVRGetImagingProperty

Parameters:

imagingMode - an imaging mode.

imagingProperty - an imaging property.

Returns:

the current value of the specified imaging property for the specified mode.

 public int getAngularUnits()

You can use QTVRGetAngularUnits to get the type of unit currently used when specifying angles.

QuickTime::QTVRGetAngularUnits

Returns:

a constant that indicates the type of angular units currently in use

 public void setAngularUnits(int units) throws QTVRException

You can use QTVRSetAngularUnits to set the type of unit used when specifying angles.

QuickTime::QTVRSetAngularUnits

Parameters:

units - A constant that indicates the type of angular units to use.

 public float ptToPanAngle(QDPoint pt) throws QTVRException

You can use QTVRPtToAngles to get the pan angle of a point.

QuickTime::QTVRPtToAngles

Parameters:

pt - A point, in the local coordinates of the graphics world of the specified movie.

 public float ptToTiltAngle(QDPoint pt) throws QTVRException

You can use QTVRPtToAngles to get the tilt angle of a point.

QuickTime::QTVRPtToAngles

Parameters:

pt - A point, in the local coordinates of the graphics world of the specified movie.

 public int panToColumn(float panAngle)

You can use QTVRPanToColumn to get the column number in the object image array that corresponds to a pan angle.

QuickTime::QTVRPanToColumn

Parameters:

panAngle - a pan angle.

Returns:

the column number in the object image array that corresponds to the specified pan angle.

 public float columnToPan(int column)

You can use QTVRColumnToPan to get the pan angle that corresponds to a column number in the object image array.

QuickTime::QTVRColumnToPan

Parameters:

column - A column number.

Returns:

the pan angle that corresponds to the specified column number in the object image array.

 public int tiltToRow(float tiltAngle)

You can use QTVRTiltToRow to get the row number in the object image array that corresponds to a tilt angle.

QuickTime::QTVRTiltToRow

Parameters:

tiltAngle - a tilt angle.

Returns:

The row number in the object image array that corresponds to the specified tilt angle.

 public float rowToTilt(int row)

You can use QTVRRowToTilt to get the tilt angle that corresponds to a row number in the object image array.

QuickTime::QTVRRowToTilt

Parameters:

row - a row number.

Returns:

the tilt angle that corresponds to the specified row number in the object image array.

 public float wrapAndConstrain(int kind,
                               float value) throws QTVRException

You can use QTVRWrapAndConstrain to preflight a change in the viewing or control characteristics of an object or panoramic node.

QuickTime::QTVRWrapAndConstrain

Parameters:

kind - a constraint type. See "Constraint Types" for a description of the available constraint types.

value - the desired value of the specified viewing characteristic.

 public void setEnteringNodeProc(QTVREnteringNode enteringNodeProc,
                                 int flags) throws QTVRException

You can use the QTVRSetEnteringNodeProc function to install or remove a node-entering procedure.

QuickTime::QTVRSetEnteringNodeProc

Parameters:

enteringNodeProc - an instance of the QTVREnteringNode object that will be called or null to remove the callback.

flags - the flags

See Also:

QTCallBack

 public void removeEnteringNodeProc()

You can use the QTVRSetEnteringNodeProc function to remove a node-entering procedure.

QuickTime::QTVRSetEnteringNodeProc

 public void setLeavingNodeProc(QTVRLeavingNode leavingNodeProc,
                                int flags) throws QTVRException

You can use the QTVRSetLeavingNodeProc function to install or remove a node-leaving procedure.

QuickTime::QTVRSetLeavingNodeProc

Parameters:

leavingNodeProc - an instance of the QTVRLeavingNode object that will be called or null to remove the callback.

flags - the flags

See Also:

QTCallBack

 public void removeLeavingNodeProc()

You can use the QTVRSetLeavingNodeProc function to remove a node-leaving procedure.

QuickTime::QTVRSetLeavingNodeProc

 public void setMouseOverHotSpotProc(QTVRMouseOverHotSpot mouseOverHotSpotProc,
                                     int flags) throws QTVRException

You can use the QTVRSetMouseOverHotSpotProc function to install or remove a mouse over hot spot procedure

QuickTime::QTVRSetMouseOverHotSpotProc

Parameters:

mouseOverHotSpotProc - an instance of the QTVRMouseOverHotSpot object that will be called or null to remove the callback.

flags - the flags

See Also:

QTCallBack

 public void removeMouseOverHotSpotProc()

You can use the QTVRSetMouseOverHotSpotProc function to remove a mouse over hot spot procedure.

QuickTime::QTVRSetMouseOverHotSpotProc

 public void installInterceptProc(int selector,
                                  QTVRInterceptor interceptProc,
                                  int flags) throws QTVRException

You can use the QTVRInstallInterceptProc function to install or remove an intercept procedure for a QuickTime VR Manager function

QuickTime::QTVRInstallInterceptProc

Parameters:

selector - only the non-mouse selectors are supported

interceptProc - the interceptor or null to remove a previously specified callback for the specified selector.

flags - the flags

See Also:

QTCallBack

 public void removeInterceptProc(int selector) throws QTVRException

You can use the QTVRInstallInterceptProc function to install or remove an intercept procedure for a QuickTime VR Manager function

QuickTime::QTVRInstallInterceptProc

Parameters:

selector - only the non-mouse selectors are supported

interceptProc - the interceptor or null to remove a previously specified callback for the specified selector.

flags - the flags

See Also:

QTCallBack

 public void callInterceptedProc(QTVRInterceptRecord qtvrMsg) throws QTVRException

This method is used by the QTVRInterceptor execute method to call the QTVR default proc for the selector that was intercepted.

QuickTime::QTVRCallInterceptedProc

Parameters:

qtvrMessage - the message as passed to the execute function

See Also:

QTCallBack

 public void showDefaultView() throws QTVRException

The showDefaultView method sets the default values of the pan angle, tilt angle, field of view, view center (for object nodes), default state, mouse-down state, and all applicable animation and control settings for the node specified by the QTVRInstance you call this on.

QuickTime::QTVRShowDefaultView

 public void setViewCenter(QDPoint viewCenter) throws QTVRException

The setViewCenter method sets the view center of the QuickTime VR movie specified by the qtvr parameter to the fixed point specified by the viewCenter parameter.

QuickTime::QTVRSetViewCenter

Parameters:

viewCenter - A QDPoint structure that contains the desired view center of the specified movie.

 public QDPoint getViewCenter() throws QTVRException

The getViewCenter method returns, in the QDPoint class, the x and y coordinates of the current view center of the QuickTime VR movie specified by the QTVRInstance you call this on.

QuickTime::QTVRGetViewCenter

Returns:

the veiw center

 public int getHotSpotType(int hotSpotID) throws QTVRException

This method gets the type of a hot spot whose ID you specify. In combination with the kQTVRGetHotSpotTypeSelector intercept selector, this allows an application to change a hot spot's type dynamically.

QuickTime::QTVRGetHotSpotType

Parameters:

hotSpotID - a hot spot ID

Returns:

the OSType of the hot spot specified by the hot spot ID.

 public void setPrescreenImagingCompleteProc(QTVRImagingComplete imageCompleteProc,
                                             int flags) throws QTVRException

This method installs a callback that is invoked every time a QTVRInstance is drawn. The application can use this callback to draw onto the QDGraphics that is supplied to the callback.

QuickTime::QTVRSetPrescreenImagingCompleteProc

Parameters:

imagingComplete - the callback object

flags - effect the conditions under which QTVR will invoke the callback

See Also:

QTCallBack

 public void removePrescreenImagingCompleteProc()

You can use the QTVRSetPrescreenImagingCompleteProc function to remove a prescreen imaging complete proc.

QuickTime::QTVRSetPrescreenImagingCompleteProc

See Also:

QTCallBack

All Packages  Class Hierarchy  This Package  Previous  Next  Index